Skip to main content
GET
/
v1
/
customers
/
segments
List segments
curl --request GET \
  --url https://api.hyperline.co/v1/customers/segments \
  --header 'Authorization: Bearer <token>'
{
  "meta": {
    "total": 1,
    "taken": 1,
    "skipped": 0
  },
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "rules": [
        {
          "id": "<string>",
          "operator": "and",
          "conditions": [
            {
              "field": "country",
              "operator": "in",
              "value": [
                "FR"
              ]
            }
          ]
        }
      ],
      "created_at": "2023-12-25",
      "updated_at": "2023-12-25"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

take
number | null
default:50
Required range: 0 <= x <= 100
skip
number | null
default:0
Required range: x >= 0

Response

200 - application/json
meta
object
required
data
object[]
required

List of Segment.